<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Faiss: /data/users/hoss/faiss/AuxIndexStructures.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Faiss
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">/data/users/hoss/faiss/AuxIndexStructures.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (c) Facebook, Inc. and its affiliates.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * This source code is licensed under the MIT license found in the</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">// -*- c++ -*-</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">// Auxiliary index structures, that are used in indexes but that can</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">// be forward-declared</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#ifndef FAISS_AUX_INDEX_STRUCTURES_H</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define FAISS_AUX_INDEX_STRUCTURES_H</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &lt;unordered_set&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &quot;Index.h&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="keyword">namespace </span>faiss {</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">/** The objective is to have a simple result structure while</span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> *  minimizing the number of mem copies in the result. The method</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> *  do_allocation can be overloaded to allocate the result tables in</span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"> *  the matrix type of a scripting language like Lua or Python. */</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="structfaiss_1_1RangeSearchResult.html">   31</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a> {</div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structfaiss_1_1RangeSearchResult.html#a29269b98c33af874d379ca4f62408b90">   32</a></span>&#160;    <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1RangeSearchResult.html#a29269b98c33af874d379ca4f62408b90">nq</a>;      <span class="comment">///&lt; nb of queries</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="structfaiss_1_1RangeSearchResult.html#aef57f9db99ca470c01bcdce0366cb6ff">   33</a></span>&#160;<span class="comment"></span>    <span class="keywordtype">size_t</span> *<a class="code" href="structfaiss_1_1RangeSearchResult.html#aef57f9db99ca470c01bcdce0366cb6ff">lims</a>;   <span class="comment">///&lt; size (nq + 1)</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    <span class="keyword">typedef</span> <a class="code" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a> idx_t;</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structfaiss_1_1RangeSearchResult.html#aa8ff848474a4cc16c5464cc4ec187824">   37</a></span>&#160;    idx_t *<a class="code" href="structfaiss_1_1RangeSearchResult.html#aa8ff848474a4cc16c5464cc4ec187824">labels</a>;     <span class="comment">///&lt; result for query i is labels[lims[i]:lims[i+1]]</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structfaiss_1_1RangeSearchResult.html#a944a93aecc7b51d8f9f35444280aa919">   38</a></span>&#160;<span class="comment"></span>    <span class="keywordtype">float</span> *<a class="code" href="structfaiss_1_1RangeSearchResult.html#a944a93aecc7b51d8f9f35444280aa919">distances</a>;  <span class="comment">///&lt; corresponding distances (not sorted)</span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structfaiss_1_1RangeSearchResult.html#a39342ad2e9ad8b90f6e95dafd3287f49">   40</a></span>&#160;    <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1RangeSearchResult.html#a39342ad2e9ad8b90f6e95dafd3287f49">buffer_size</a>; <span class="comment">///&lt; size of the result buffers used</span></div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment"></span><span class="comment"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">    /// lims must be allocated on input to range_search.</span></div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment"></span>    <span class="keyword">explicit</span> <a class="code" href="structfaiss_1_1RangeSearchResult.html#a56dca2b151bcf16f5d488aff321b9501">RangeSearchResult</a> (idx_t <a class="code" href="structfaiss_1_1RangeSearchResult.html#a29269b98c33af874d379ca4f62408b90">nq</a>, <span class="keywordtype">bool</span> alloc_lims=<span class="keyword">true</span>);</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment">    /// called when lims contains the nb of elements result entries</span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment">    /// for each query</span></div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment"></span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1RangeSearchResult.html#a34c4ba599c0cec45972af19e1f98f22a">do_allocation</a> ();</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <span class="keyword">virtual</span> ~<a class="code" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a> ();</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;};</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment">/** Encapsulates a set of ids to remove. */</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structfaiss_1_1IDSelector.html">   54</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1IDSelector.html">IDSelector</a> {</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    <span class="keyword">typedef</span> <a class="code" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a> idx_t;</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">bool</span> is_member (idx_t <span class="keywordtype">id</span>) <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    <span class="keyword">virtual</span> ~<a class="code" href="structfaiss_1_1IDSelector.html">IDSelector</a>() {}</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;};</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment">/** remove ids between [imni, imax) */</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="structfaiss_1_1IDSelectorRange.html">   63</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1IDSelectorRange.html">IDSelectorRange</a>: <a class="code" href="structfaiss_1_1IDSelector.html">IDSelector</a> {</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    idx_t imin, imax;</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    <a class="code" href="structfaiss_1_1IDSelectorRange.html">IDSelectorRange</a> (idx_t imin, idx_t imax);</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    <span class="keywordtype">bool</span> is_member(idx_t <span class="keywordtype">id</span>) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    ~<a class="code" href="structfaiss_1_1IDSelectorRange.html">IDSelectorRange</a>()<span class="keyword"> override </span>{}</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;};</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment">/** Remove ids from a set. Repetitions of ids in the indices set</span></div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment"> * passed to the constructor does not hurt performance. The hash</span></div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment"> * function used for the bloom filter and GCC&#39;s implementation of</span></div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment"> * unordered_set are just the least significant bits of the id. This</span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment"> * works fine for random ids or ids in sequences but will produce many</span></div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment"> * hash collisions if lsb&#39;s are always the same */</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="structfaiss_1_1IDSelectorBatch.html">   78</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1IDSelectorBatch.html">IDSelectorBatch</a>: <a class="code" href="structfaiss_1_1IDSelector.html">IDSelector</a> {</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    std::unordered_set&lt;idx_t&gt; set;</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> uint8_t;</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    std::vector&lt;uint8_t&gt; bloom; <span class="comment">// assumes low bits of id are a good hash value</span></div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    <span class="keywordtype">int</span> nbits;</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    idx_t mask;</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    <a class="code" href="structfaiss_1_1IDSelectorBatch.html">IDSelectorBatch</a> (<span class="keywordtype">long</span> n, <span class="keyword">const</span> idx_t *indices);</div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;    <span class="keywordtype">bool</span> is_member(idx_t <span class="keywordtype">id</span>) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;    ~<a class="code" href="structfaiss_1_1IDSelectorBatch.html">IDSelectorBatch</a>()<span class="keyword"> override </span>{}</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;};</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="comment">/****************************************************************</span></div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="comment"> * Result structures for range search.</span></div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="comment"> * The main constraint here is that we want to support parallel</span></div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="comment"> * queries from different threads in various ways: 1 thread per query,</span></div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="comment"> * several threads per query. We store the actual results in blocks of</span></div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="comment"> * fixed size rather than exponentially increasing memory. At the end,</span></div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment"> * we copy the block content to a linear result array.</span></div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment"> *****************************************************************/</span></div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment">/** List of temporary buffers used to store results before they are</span></div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment"> *  copied to the RangeSearchResult object. */</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="structfaiss_1_1BufferList.html">  104</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1BufferList.html">BufferList</a> {</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;    <span class="keyword">typedef</span> <a class="code" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a> idx_t;</div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;</div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;    <span class="comment">// buffer sizes in # entries</span></div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;    <span class="keywordtype">size_t</span> buffer_size;</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;</div>
<div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="structfaiss_1_1BufferList_1_1Buffer.html">  110</a></span>&#160;    <span class="keyword">struct </span><a class="code" href="structfaiss_1_1BufferList_1_1Buffer.html">Buffer</a> {</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;        idx_t *ids;</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;        <span class="keywordtype">float</span> *dis;</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;    };</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;</div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;    std::vector&lt;Buffer&gt; buffers;</div>
<div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="structfaiss_1_1BufferList.html#af4d7ddcd77f328a12a7da89d8febe5d9">  116</a></span>&#160;    <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1BufferList.html#af4d7ddcd77f328a12a7da89d8febe5d9">wp</a>; <span class="comment">///&lt; write pointer in the last buffer.</span></div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;    <span class="keyword">explicit</span> <a class="code" href="structfaiss_1_1BufferList.html">BufferList</a> (<span class="keywordtype">size_t</span> buffer_size);</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;</div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;    ~<a class="code" href="structfaiss_1_1BufferList.html">BufferList</a> ();</div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="comment">    /// create a new buffer</span></div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<span class="comment"></span>    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1BufferList.html#aa124ff3a7e6a98960e12a8b32bdaec42">append_buffer</a> ();</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="comment">    /// add one result, possibly appending a new buffer if needed</span></div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="comment"></span>    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1BufferList.html#aa17f17a53b45bb39b0724d6493ab33c9">add</a> (idx_t <span class="keywordtype">id</span>, <span class="keywordtype">float</span> dis);</div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="comment">    /// copy elemnts ofs:ofs+n-1 seen as linear data in the buffers to</span></div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="comment">    /// tables dest_ids, dest_dis</span></div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="comment"></span>    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1BufferList.html#a78b70417a9ba5b27553b3134f1190958">copy_range</a> (<span class="keywordtype">size_t</span> ofs, <span class="keywordtype">size_t</span> n,</div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;                     idx_t * dest_ids, <span class="keywordtype">float</span> *dest_dis);</div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;</div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;};</div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;</div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1RangeSearchPartialResult.html">RangeSearchPartialResult</a>;</div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="comment">/// result structure for a single query</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"><a class="line" href="structfaiss_1_1RangeQueryResult.html">  138</a></span>&#160;<span class="comment"></span><span class="keyword">struct </span><a class="code" href="structfaiss_1_1RangeQueryResult.html">RangeQueryResult</a> {</div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;    <span class="keyword">using</span> idx_t = <a class="code" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a>;</div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;    idx_t qno;    <span class="comment">//&lt; id of the query</span></div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;    <span class="keywordtype">size_t</span> nres;  <span class="comment">//&lt; nb of results for this query</span></div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;    <a class="code" href="structfaiss_1_1RangeSearchPartialResult.html">RangeSearchPartialResult</a> * pres;</div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment">    /// called by search function to report a new result</span></div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="comment"></span>    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1RangeQueryResult.html#aed669959bc918d9a554f236d40789084">add</a> (<span class="keywordtype">float</span> dis, idx_t <span class="keywordtype">id</span>);</div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;};</div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment">/// the entries in the buffers are split per query</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"><a class="line" href="structfaiss_1_1RangeSearchPartialResult.html">  149</a></span>&#160;<span class="comment"></span><span class="keyword">struct </span><a class="code" href="structfaiss_1_1RangeSearchPartialResult.html">RangeSearchPartialResult</a>: <a class="code" href="structfaiss_1_1BufferList.html">BufferList</a> {</div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;    <a class="code" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a> * res;</div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;<span class="comment">    /// eventually the result will be stored in res_in</span></div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<span class="comment"></span>    <span class="keyword">explicit</span> <a class="code" href="structfaiss_1_1RangeSearchPartialResult.html#a41aaed4f59e7a6a99e2a643dfff483f5">RangeSearchPartialResult</a> (<a class="code" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a> * res_in);</div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;<span class="comment">    /// query ids + nb of results per query.</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"><a class="line" href="structfaiss_1_1RangeSearchPartialResult.html#abd6ae2a92bc18b6528aadf39370d041c">  156</a></span>&#160;<span class="comment"></span>    std::vector&lt;RangeQueryResult&gt; <a class="code" href="structfaiss_1_1RangeSearchPartialResult.html#abd6ae2a92bc18b6528aadf39370d041c">queries</a>;</div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;<span class="comment">    /// begin a new result</span></div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="comment"></span>    <a class="code" href="structfaiss_1_1RangeQueryResult.html">RangeQueryResult</a> &amp; <a class="code" href="structfaiss_1_1RangeSearchPartialResult.html#a0ba199c22ed09aebb0f7238229b516e9">new_result</a> (idx_t qno);</div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;</div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;    <span class="comment">/*****************************************</span></div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="comment">     * functions used at the end of the search to merge the result</span></div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="comment">     * lists */</span></div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;    <span class="keywordtype">void</span> finalize ();</div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;<span class="comment">    /// called by range_search before do_allocation</span></div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<span class="comment"></span>    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1RangeSearchPartialResult.html#ab6a385008493c7b630e4e7bc56e3da74">set_lims</a> ();</div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;<span class="comment">    /// called by range_search after do_allocation</span></div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;<span class="comment"></span>    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1RangeSearchPartialResult.html#ad323d8ea8914d9071aecff83f69ee8e4">copy_result</a> (<span class="keywordtype">bool</span> incremental = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;<span class="comment">    /// merge a set of PartialResult&#39;s into one RangeSearchResult</span></div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;<span class="comment">    /// on ouptut the partialresults are empty!</span></div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;<span class="comment"></span>    <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1RangeSearchPartialResult.html#ac01a679f4fa7a00e8cb0dfe15f50d422">merge</a> (std::vector &lt;RangeSearchPartialResult *&gt; &amp;</div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;                       partial_results, <span class="keywordtype">bool</span> do_delete=<span class="keyword">true</span>);</div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;</div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;};</div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;</div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;<span class="comment">/***********************************************************</span></div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;<span class="comment"> * Abstract I/O objects</span></div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;<span class="comment"> ***********************************************************/</span></div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;</div>
<div class="line"><a name="l00183"></a><span class="lineno"><a class="line" href="structfaiss_1_1IOReader.html">  183</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1IOReader.html">IOReader</a> {</div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;    <span class="comment">// name that can be used in error messages</span></div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;    std::string name;</div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;</div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;    <span class="comment">// fread</span></div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> operator()(</div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;         <span class="keywordtype">void</span> *ptr, <span class="keywordtype">size_t</span> size, <span class="keywordtype">size_t</span> nitems) = 0;</div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;</div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;    <span class="comment">// return a file number that can be memory-mapped</span></div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">int</span> fileno ();</div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;</div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;    <span class="keyword">virtual</span> ~<a class="code" href="structfaiss_1_1IOReader.html">IOReader</a>() {}</div>
<div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;};</div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;</div>
<div class="line"><a name="l00197"></a><span class="lineno"><a class="line" href="structfaiss_1_1IOWriter.html">  197</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1IOWriter.html">IOWriter</a> {</div>
<div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;    <span class="comment">// name that can be used in error messages</span></div>
<div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;    std::string name;</div>
<div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;</div>
<div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;    <span class="comment">// fwrite</span></div>
<div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> operator()(</div>
<div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;         <span class="keyword">const</span> <span class="keywordtype">void</span> *ptr, <span class="keywordtype">size_t</span> size, <span class="keywordtype">size_t</span> nitems) = 0;</div>
<div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;</div>
<div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;    <span class="comment">// return a file number that can be memory-mapped</span></div>
<div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">int</span> fileno ();</div>
<div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;</div>
<div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;    <span class="keyword">virtual</span> ~<a class="code" href="structfaiss_1_1IOWriter.html">IOWriter</a>() {}</div>
<div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;};</div>
<div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160;</div>
<div class="line"><a name="l00211"></a><span class="lineno">  211</span>&#160;</div>
<div class="line"><a name="l00212"></a><span class="lineno"><a class="line" href="structfaiss_1_1VectorIOReader.html">  212</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1VectorIOReader.html">VectorIOReader</a>:<a class="code" href="structfaiss_1_1IOReader.html">IOReader</a> {</div>
<div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;    std::vector&lt;uint8_t&gt; data;</div>
<div class="line"><a name="l00214"></a><span class="lineno">  214</span>&#160;    <span class="keywordtype">size_t</span> rp = 0;</div>
<div class="line"><a name="l00215"></a><span class="lineno">  215</span>&#160;    <span class="keywordtype">size_t</span> operator()(<span class="keywordtype">void</span> *ptr, <span class="keywordtype">size_t</span> size, <span class="keywordtype">size_t</span> nitems) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160;};</div>
<div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160;</div>
<div class="line"><a name="l00218"></a><span class="lineno"><a class="line" href="structfaiss_1_1VectorIOWriter.html">  218</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1VectorIOWriter.html">VectorIOWriter</a>:<a class="code" href="structfaiss_1_1IOWriter.html">IOWriter</a> {</div>
<div class="line"><a name="l00219"></a><span class="lineno">  219</span>&#160;    std::vector&lt;uint8_t&gt; data;</div>
<div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;    <span class="keywordtype">size_t</span> operator()(<span class="keyword">const</span> <span class="keywordtype">void</span> *ptr, <span class="keywordtype">size_t</span> size, <span class="keywordtype">size_t</span> nitems) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;};</div>
<div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160;</div>
<div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;<span class="comment">/***********************************************************</span></div>
<div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160;<span class="comment"> * The distance computer maintains a current query and computes</span></div>
<div class="line"><a name="l00225"></a><span class="lineno">  225</span>&#160;<span class="comment"> * distances to elements in an index that supports random access.</span></div>
<div class="line"><a name="l00226"></a><span class="lineno">  226</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;<span class="comment"> * The DistanceComputer is not intended to be thread-safe (eg. because</span></div>
<div class="line"><a name="l00228"></a><span class="lineno">  228</span>&#160;<span class="comment"> * it maintains counters) so the distance functions are not const,</span></div>
<div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;<span class="comment"> * instanciate one from each thread if needed.</span></div>
<div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160;<span class="comment"> ***********************************************************/</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"><a class="line" href="structfaiss_1_1DistanceComputer.html">  231</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1DistanceComputer.html">DistanceComputer</a> {</div>
<div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160;     <span class="keyword">using</span> idx_t = <a class="code" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a>;</div>
<div class="line"><a name="l00233"></a><span class="lineno">  233</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00234"></a><span class="lineno">  234</span>&#160;<span class="comment">     /// called before computing distances</span></div>
<div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;<span class="comment"></span>     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1DistanceComputer.html#aaa4472453365b786adc2ab21e9cee5ec">set_query</a>(<span class="keyword">const</span> <span class="keywordtype">float</span> *x) = 0;</div>
<div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;<span class="comment">     /// compute distance of vector i to current query</span></div>
<div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;<span class="comment"></span>     <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="structfaiss_1_1DistanceComputer.html#a4d71be87bbd904043f6bc2fae03d037f">operator () </a>(idx_t i) = 0;</div>
<div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160;<span class="comment">     /// compute distance between two stored vectors</span></div>
<div class="line"><a name="l00241"></a><span class="lineno">  241</span>&#160;<span class="comment"></span>     <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="structfaiss_1_1DistanceComputer.html#a4b7236a757c788401aac00598ed902c7">symmetric_dis</a> (idx_t i, idx_t j) = 0;</div>
<div class="line"><a name="l00242"></a><span class="lineno">  242</span>&#160;</div>
<div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160;     <span class="keyword">virtual</span> ~<a class="code" href="structfaiss_1_1DistanceComputer.html">DistanceComputer</a>() {}</div>
<div class="line"><a name="l00244"></a><span class="lineno">  244</span>&#160;};</div>
<div class="line"><a name="l00245"></a><span class="lineno">  245</span>&#160;</div>
<div class="line"><a name="l00246"></a><span class="lineno">  246</span>&#160;<span class="comment">/***********************************************************</span></div>
<div class="line"><a name="l00247"></a><span class="lineno">  247</span>&#160;<span class="comment"> * Interrupt callback</span></div>
<div class="line"><a name="l00248"></a><span class="lineno">  248</span>&#160;<span class="comment"> ***********************************************************/</span></div>
<div class="line"><a name="l00249"></a><span class="lineno">  249</span>&#160;</div>
<div class="line"><a name="l00250"></a><span class="lineno"><a class="line" href="structfaiss_1_1InterruptCallback.html">  250</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1InterruptCallback.html">InterruptCallback</a> {</div>
<div class="line"><a name="l00251"></a><span class="lineno">  251</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">bool</span> want_interrupt () = 0;</div>
<div class="line"><a name="l00252"></a><span class="lineno">  252</span>&#160;    <span class="keyword">virtual</span> ~<a class="code" href="structfaiss_1_1InterruptCallback.html">InterruptCallback</a>() {}</div>
<div class="line"><a name="l00253"></a><span class="lineno">  253</span>&#160;</div>
<div class="line"><a name="l00254"></a><span class="lineno">  254</span>&#160;    <span class="keyword">static</span> std::unique_ptr&lt;InterruptCallback&gt; instance;</div>
<div class="line"><a name="l00255"></a><span class="lineno">  255</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00256"></a><span class="lineno">  256</span>&#160;<span class="comment">    /** check if:</span></div>
<div class="line"><a name="l00257"></a><span class="lineno">  257</span>&#160;<span class="comment">     * - an interrupt callback is set</span></div>
<div class="line"><a name="l00258"></a><span class="lineno">  258</span>&#160;<span class="comment">     * - the callback retuns true</span></div>
<div class="line"><a name="l00259"></a><span class="lineno">  259</span>&#160;<span class="comment">     * if this is the case, then throw an exception</span></div>
<div class="line"><a name="l00260"></a><span class="lineno">  260</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00261"></a><span class="lineno">  261</span>&#160;    <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1InterruptCallback.html#a6b7b2569b2d3a88daea65b469a24e378">check</a> ();</div>
<div class="line"><a name="l00262"></a><span class="lineno">  262</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00263"></a><span class="lineno">  263</span>&#160;<span class="comment">    /// same as check() but return true if is interrupted instead of</span></div>
<div class="line"><a name="l00264"></a><span class="lineno">  264</span>&#160;<span class="comment">    /// throwing</span></div>
<div class="line"><a name="l00265"></a><span class="lineno">  265</span>&#160;<span class="comment"></span>    <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1InterruptCallback.html#adb241fbde51ecd1003cefb8295cd1e0d">is_interrupted</a> ();</div>
<div class="line"><a name="l00266"></a><span class="lineno">  266</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00267"></a><span class="lineno">  267</span>&#160;<span class="comment">    /** assuming each iteration takes a certain number of flops, what</span></div>
<div class="line"><a name="l00268"></a><span class="lineno">  268</span>&#160;<span class="comment">     * is a reasonable interval to check for interrupts?</span></div>
<div class="line"><a name="l00269"></a><span class="lineno">  269</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00270"></a><span class="lineno">  270</span>&#160;    <span class="keyword">static</span> <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InterruptCallback.html#a1e4134a6b41f93d2405e030527573728">get_period_hint</a> (<span class="keywordtype">size_t</span> flops);</div>
<div class="line"><a name="l00271"></a><span class="lineno">  271</span>&#160;</div>
<div class="line"><a name="l00272"></a><span class="lineno">  272</span>&#160;};</div>
<div class="line"><a name="l00273"></a><span class="lineno">  273</span>&#160;</div>
<div class="line"><a name="l00274"></a><span class="lineno">  274</span>&#160;</div>
<div class="line"><a name="l00275"></a><span class="lineno">  275</span>&#160;</div>
<div class="line"><a name="l00276"></a><span class="lineno">  276</span>&#160;}; <span class="comment">// namespace faiss</span></div>
<div class="line"><a name="l00277"></a><span class="lineno">  277</span>&#160;</div>
<div class="line"><a name="l00278"></a><span class="lineno">  278</span>&#160;</div>
<div class="line"><a name="l00279"></a><span class="lineno">  279</span>&#160;</div>
<div class="line"><a name="l00280"></a><span class="lineno">  280</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="structfaiss_1_1InterruptCallback_html"><div class="ttname"><a href="structfaiss_1_1InterruptCallback.html">faiss::InterruptCallback</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00250">AuxIndexStructures.h:250</a></div></div>
<div class="ttc" id="structfaiss_1_1IDSelectorBatch_html"><div class="ttname"><a href="structfaiss_1_1IDSelectorBatch.html">faiss::IDSelectorBatch</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00078">AuxIndexStructures.h:78</a></div></div>
<div class="ttc" id="structfaiss_1_1DistanceComputer_html_a4b7236a757c788401aac00598ed902c7"><div class="ttname"><a href="structfaiss_1_1DistanceComputer.html#a4b7236a757c788401aac00598ed902c7">faiss::DistanceComputer::symmetric_dis</a></div><div class="ttdeci">virtual float symmetric_dis(idx_t i, idx_t j)=0</div><div class="ttdoc">compute distance between two stored vectors </div></div>
<div class="ttc" id="structfaiss_1_1RangeSearchPartialResult_html_abd6ae2a92bc18b6528aadf39370d041c"><div class="ttname"><a href="structfaiss_1_1RangeSearchPartialResult.html#abd6ae2a92bc18b6528aadf39370d041c">faiss::RangeSearchPartialResult::queries</a></div><div class="ttdeci">std::vector&lt; RangeQueryResult &gt; queries</div><div class="ttdoc">query ids + nb of results per query. </div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00156">AuxIndexStructures.h:156</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeSearchResult_html_a29269b98c33af874d379ca4f62408b90"><div class="ttname"><a href="structfaiss_1_1RangeSearchResult.html#a29269b98c33af874d379ca4f62408b90">faiss::RangeSearchResult::nq</a></div><div class="ttdeci">size_t nq</div><div class="ttdoc">nb of queries </div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00032">AuxIndexStructures.h:32</a></div></div>
<div class="ttc" id="structfaiss_1_1DistanceComputer_html_aaa4472453365b786adc2ab21e9cee5ec"><div class="ttname"><a href="structfaiss_1_1DistanceComputer.html#aaa4472453365b786adc2ab21e9cee5ec">faiss::DistanceComputer::set_query</a></div><div class="ttdeci">virtual void set_query(const float *x)=0</div><div class="ttdoc">called before computing distances </div></div>
<div class="ttc" id="structfaiss_1_1RangeQueryResult_html"><div class="ttname"><a href="structfaiss_1_1RangeQueryResult.html">faiss::RangeQueryResult</a></div><div class="ttdoc">result structure for a single query </div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00138">AuxIndexStructures.h:138</a></div></div>
<div class="ttc" id="structfaiss_1_1BufferList_html_aa124ff3a7e6a98960e12a8b32bdaec42"><div class="ttname"><a href="structfaiss_1_1BufferList.html#aa124ff3a7e6a98960e12a8b32bdaec42">faiss::BufferList::append_buffer</a></div><div class="ttdeci">void append_buffer()</div><div class="ttdoc">create a new buffer </div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8cpp_source.html#l00090">AuxIndexStructures.cpp:90</a></div></div>
<div class="ttc" id="structfaiss_1_1DistanceComputer_html"><div class="ttname"><a href="structfaiss_1_1DistanceComputer.html">faiss::DistanceComputer</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00231">AuxIndexStructures.h:231</a></div></div>
<div class="ttc" id="structfaiss_1_1BufferList_html_a78b70417a9ba5b27553b3134f1190958"><div class="ttname"><a href="structfaiss_1_1BufferList.html#a78b70417a9ba5b27553b3134f1190958">faiss::BufferList::copy_range</a></div><div class="ttdeci">void copy_range(size_t ofs, size_t n, idx_t *dest_ids, float *dest_dis)</div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8cpp_source.html#l00099">AuxIndexStructures.cpp:99</a></div></div>
<div class="ttc" id="structfaiss_1_1IDSelector_html"><div class="ttname"><a href="structfaiss_1_1IDSelector.html">faiss::IDSelector</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00054">AuxIndexStructures.h:54</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeSearchPartialResult_html_ab6a385008493c7b630e4e7bc56e3da74"><div class="ttname"><a href="structfaiss_1_1RangeSearchPartialResult.html#ab6a385008493c7b630e4e7bc56e3da74">faiss::RangeSearchPartialResult::set_lims</a></div><div class="ttdeci">void set_lims()</div><div class="ttdoc">called by range_search before do_allocation </div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8cpp_source.html#l00159">AuxIndexStructures.cpp:159</a></div></div>
<div class="ttc" id="structfaiss_1_1DistanceComputer_html_a4d71be87bbd904043f6bc2fae03d037f"><div class="ttname"><a href="structfaiss_1_1DistanceComputer.html#a4d71be87bbd904043f6bc2fae03d037f">faiss::DistanceComputer::operator()</a></div><div class="ttdeci">virtual float operator()(idx_t i)=0</div><div class="ttdoc">compute distance of vector i to current query </div></div>
<div class="ttc" id="structfaiss_1_1VectorIOReader_html"><div class="ttname"><a href="structfaiss_1_1VectorIOReader.html">faiss::VectorIOReader</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00212">AuxIndexStructures.h:212</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeSearchResult_html_a56dca2b151bcf16f5d488aff321b9501"><div class="ttname"><a href="structfaiss_1_1RangeSearchResult.html#a56dca2b151bcf16f5d488aff321b9501">faiss::RangeSearchResult::RangeSearchResult</a></div><div class="ttdeci">RangeSearchResult(idx_t nq, bool alloc_lims=true)</div><div class="ttdoc">lims must be allocated on input to range_search. </div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8cpp_source.html#l00024">AuxIndexStructures.cpp:24</a></div></div>
<div class="ttc" id="structfaiss_1_1InterruptCallback_html_a6b7b2569b2d3a88daea65b469a24e378"><div class="ttname"><a href="structfaiss_1_1InterruptCallback.html#a6b7b2569b2d3a88daea65b469a24e378">faiss::InterruptCallback::check</a></div><div class="ttdeci">static void check()</div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8cpp_source.html#l00307">AuxIndexStructures.cpp:307</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_ad3f0d3071f987baabbdd3da4500c87ea"><div class="ttname"><a href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">faiss::Index::idx_t</a></div><div class="ttdeci">long idx_t</div><div class="ttdoc">all indices are this type </div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00062">Index.h:62</a></div></div>
<div class="ttc" id="structfaiss_1_1BufferList_html_af4d7ddcd77f328a12a7da89d8febe5d9"><div class="ttname"><a href="structfaiss_1_1BufferList.html#af4d7ddcd77f328a12a7da89d8febe5d9">faiss::BufferList::wp</a></div><div class="ttdeci">size_t wp</div><div class="ttdoc">write pointer in the last buffer. </div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00116">AuxIndexStructures.h:116</a></div></div>
<div class="ttc" id="structfaiss_1_1VectorIOWriter_html"><div class="ttname"><a href="structfaiss_1_1VectorIOWriter.html">faiss::VectorIOWriter</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00218">AuxIndexStructures.h:218</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeSearchResult_html_a944a93aecc7b51d8f9f35444280aa919"><div class="ttname"><a href="structfaiss_1_1RangeSearchResult.html#a944a93aecc7b51d8f9f35444280aa919">faiss::RangeSearchResult::distances</a></div><div class="ttdeci">float * distances</div><div class="ttdoc">corresponding distances (not sorted) </div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00038">AuxIndexStructures.h:38</a></div></div>
<div class="ttc" id="structfaiss_1_1BufferList_html_aa17f17a53b45bb39b0724d6493ab33c9"><div class="ttname"><a href="structfaiss_1_1BufferList.html#aa17f17a53b45bb39b0724d6493ab33c9">faiss::BufferList::add</a></div><div class="ttdeci">void add(idx_t id, float dis)</div><div class="ttdoc">add one result, possibly appending a new buffer if needed </div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8cpp_source.html#l00079">AuxIndexStructures.cpp:79</a></div></div>
<div class="ttc" id="structfaiss_1_1IDSelectorRange_html"><div class="ttname"><a href="structfaiss_1_1IDSelectorRange.html">faiss::IDSelectorRange</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00063">AuxIndexStructures.h:63</a></div></div>
<div class="ttc" id="structfaiss_1_1IOReader_html"><div class="ttname"><a href="structfaiss_1_1IOReader.html">faiss::IOReader</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00183">AuxIndexStructures.h:183</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeSearchResult_html_a34c4ba599c0cec45972af19e1f98f22a"><div class="ttname"><a href="structfaiss_1_1RangeSearchResult.html#a34c4ba599c0cec45972af19e1f98f22a">faiss::RangeSearchResult::do_allocation</a></div><div class="ttdeci">virtual void do_allocation()</div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8cpp_source.html#l00038">AuxIndexStructures.cpp:38</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeSearchPartialResult_html"><div class="ttname"><a href="structfaiss_1_1RangeSearchPartialResult.html">faiss::RangeSearchPartialResult</a></div><div class="ttdoc">the entries in the buffers are split per query </div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00149">AuxIndexStructures.h:149</a></div></div>
<div class="ttc" id="structfaiss_1_1InterruptCallback_html_adb241fbde51ecd1003cefb8295cd1e0d"><div class="ttname"><a href="structfaiss_1_1InterruptCallback.html#adb241fbde51ecd1003cefb8295cd1e0d">faiss::InterruptCallback::is_interrupted</a></div><div class="ttdeci">static bool is_interrupted()</div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8cpp_source.html#l00316">AuxIndexStructures.cpp:316</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeSearchResult_html"><div class="ttname"><a href="structfaiss_1_1RangeSearchResult.html">faiss::RangeSearchResult</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00031">AuxIndexStructures.h:31</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeSearchPartialResult_html_ad323d8ea8914d9071aecff83f69ee8e4"><div class="ttname"><a href="structfaiss_1_1RangeSearchPartialResult.html#ad323d8ea8914d9071aecff83f69ee8e4">faiss::RangeSearchPartialResult::copy_result</a></div><div class="ttdeci">void copy_result(bool incremental=false)</div><div class="ttdoc">called by range_search after do_allocation </div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8cpp_source.html#l00168">AuxIndexStructures.cpp:168</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeSearchPartialResult_html_ac01a679f4fa7a00e8cb0dfe15f50d422"><div class="ttname"><a href="structfaiss_1_1RangeSearchPartialResult.html#ac01a679f4fa7a00e8cb0dfe15f50d422">faiss::RangeSearchPartialResult::merge</a></div><div class="ttdeci">static void merge(std::vector&lt; RangeSearchPartialResult * &gt; &amp;partial_results, bool do_delete=true)</div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8cpp_source.html#l00184">AuxIndexStructures.cpp:184</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeSearchPartialResult_html_a0ba199c22ed09aebb0f7238229b516e9"><div class="ttname"><a href="structfaiss_1_1RangeSearchPartialResult.html#a0ba199c22ed09aebb0f7238229b516e9">faiss::RangeSearchPartialResult::new_result</a></div><div class="ttdeci">RangeQueryResult &amp; new_result(idx_t qno)</div><div class="ttdoc">begin a new result </div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8cpp_source.html#l00137">AuxIndexStructures.cpp:137</a></div></div>
<div class="ttc" id="structfaiss_1_1BufferList_1_1Buffer_html"><div class="ttname"><a href="structfaiss_1_1BufferList_1_1Buffer.html">faiss::BufferList::Buffer</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00110">AuxIndexStructures.h:110</a></div></div>
<div class="ttc" id="structfaiss_1_1IOWriter_html"><div class="ttname"><a href="structfaiss_1_1IOWriter.html">faiss::IOWriter</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00197">AuxIndexStructures.h:197</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeSearchResult_html_a39342ad2e9ad8b90f6e95dafd3287f49"><div class="ttname"><a href="structfaiss_1_1RangeSearchResult.html#a39342ad2e9ad8b90f6e95dafd3287f49">faiss::RangeSearchResult::buffer_size</a></div><div class="ttdeci">size_t buffer_size</div><div class="ttdoc">size of the result buffers used </div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00040">AuxIndexStructures.h:40</a></div></div>
<div class="ttc" id="structfaiss_1_1InterruptCallback_html_a1e4134a6b41f93d2405e030527573728"><div class="ttname"><a href="structfaiss_1_1InterruptCallback.html#a1e4134a6b41f93d2405e030527573728">faiss::InterruptCallback::get_period_hint</a></div><div class="ttdeci">static size_t get_period_hint(size_t flops)</div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8cpp_source.html#l00324">AuxIndexStructures.cpp:324</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeSearchResult_html_aef57f9db99ca470c01bcdce0366cb6ff"><div class="ttname"><a href="structfaiss_1_1RangeSearchResult.html#aef57f9db99ca470c01bcdce0366cb6ff">faiss::RangeSearchResult::lims</a></div><div class="ttdeci">size_t * lims</div><div class="ttdoc">size (nq + 1) </div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00033">AuxIndexStructures.h:33</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeQueryResult_html_aed669959bc918d9a554f236d40789084"><div class="ttname"><a href="structfaiss_1_1RangeQueryResult.html#aed669959bc918d9a554f236d40789084">faiss::RangeQueryResult::add</a></div><div class="ttdeci">void add(float dis, idx_t id)</div><div class="ttdoc">called by search function to report a new result </div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8cpp_source.html#l00122">AuxIndexStructures.cpp:122</a></div></div>
<div class="ttc" id="structfaiss_1_1BufferList_html"><div class="ttname"><a href="structfaiss_1_1BufferList.html">faiss::BufferList</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00104">AuxIndexStructures.h:104</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeSearchResult_html_aa8ff848474a4cc16c5464cc4ec187824"><div class="ttname"><a href="structfaiss_1_1RangeSearchResult.html#aa8ff848474a4cc16c5464cc4ec187824">faiss::RangeSearchResult::labels</a></div><div class="ttdeci">idx_t * labels</div><div class="ttdoc">result for query i is labels[lims[i]:lims[i+1]] </div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00037">AuxIndexStructures.h:37</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeSearchPartialResult_html_a41aaed4f59e7a6a99e2a643dfff483f5"><div class="ttname"><a href="structfaiss_1_1RangeSearchPartialResult.html#a41aaed4f59e7a6a99e2a643dfff483f5">faiss::RangeSearchPartialResult::RangeSearchPartialResult</a></div><div class="ttdeci">RangeSearchPartialResult(RangeSearchResult *res_in)</div><div class="ttdoc">eventually the result will be stored in res_in </div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8cpp_source.html#l00129">AuxIndexStructures.cpp:129</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
